# <%= @title %>

* [Source](https://github.com/ronin-ruby/<%= @name %>)
* [Issues](https://github.com/ronin-ruby/<%= @name %>/issues)
* [Documentation](http://rubydoc.info/gems/<%= @name %>/frames)
* [Email](mailto:<%= @safe_email %>)

## Description

<%= @title %> is a Ronin library.

[Ronin] is a Ruby platform for exploit development and security research.
Ronin allows for the rapid development and distribution of code, exploits
or payloads over many common Source-Code-Management (SCM) systems.

[Ronin]: http://ronin-ruby.github.com/

## Features

## Synopsis

Start the Ronin console with <%= @title %> preloaded:

    $ ronin <%= @dir_name %>

## Examples

## Requirements

* [ronin] ~> 1.0
<%- unless @generators.empty? -%>
* [ronin-gen] ~> 1.0
<%- end -%>

## Install

### Stable

    $ gem install <%= @name %>

### Edge

    $ git clone git://github.com/ronin-ruby/<%= @name %>.git
    $ cd <%= @name %>/
    $ bundle install
    $ ./bin/<%= @dir_name %>

## License

Copyright (c) <%= Time.new.strftime("%Y") %> <%= @author %> (<%= @safe_email %>)

This file is part of <%= @title %>.

<%= @title %> is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

<%= @title %> is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with <%= @title %>.  If not, see <http://www.gnu.org/licenses/>.

[Ronin]: http://ronin-ruby.github.com/

[ronin]: https://github.com/ronin-ruby/ronin#readme
<%- unless @generators.empty? -%>
[ronin-gen]: https://github.com/ronin-ruby/ronin-gen#readme
<%- end -%>
